right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (592 APIs)

API Host: https://obp-apisandbox.joinfincubator.com
Bank
Accounts
Views
Counterparties
Transactions

Create new Book Mark Bank And Account

Create new Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanCreateDynamicEntity_BookMarkBankAndAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_createBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Create new My Book Mark Bank And Account

Create new My Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_createMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_createMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Delete Book Mark Bank And Account by id

Delete Book Mark Bank And Account by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanDeleteDynamicEntity_BookMarkBankAndAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_deleteBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Delete My Book Mark Bank And Account by id

Delete My Book Mark Bank And Account by id

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_deleteMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_deleteMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account List

Get Book Mark Bank And Account List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account_list":[{
    "bank-id":"gh.29.uk",
    "book_mark_bank_and_account":{
      "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Required Roles:
  • CanGetDynamicEntity_BookMarkBankAndAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getBookMarkBankAndAccountList_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getBookMarkBankAndAccountList_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get Book Mark Bank And Account by id

Get Book Mark Bank And Account by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanGetDynamicEntity_BookMarkBankAndAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getSingleBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account List

Get My Book Mark Bank And Account List.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Can do filter on the fields
e.g: /BookMarkBankAndAccount?name=James%20Brown&number=123.456&number=11.11
Will do filter by this rule: name == "James Brown" && (number==123.456 || number=11.11)

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account_list":[{
    "bank-id":"gh.29.uk",
    "book_mark_bank_and_account":{
      "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
      "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
      "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
      "tag_1":"Done"
    }
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getMyBookMarkBankAndAccountList_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getMyBookMarkBankAndAccountList_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Get My Book Mark Bank And Account by id

Get My Book Mark Bank And Account by id.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_getSingleMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_getSingleMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Update Book Mark Bank And Account

Update Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_BookMarkBankAndAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_updateBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,

Update My Book Mark Bank And Account

Update My Book Mark Bank And Account.

This entity stores bank_id and account_id

Property List:

  • bank_id: A bank_id
  • account_id: An account_id
  • tag_1: To tag the record

MethodRouting settings example:

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"BookMarkBankAndAccount"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

Authentication is Mandatory

Typical Successful Response: 

								
									
{
  "bank-id":"gh.29.uk",
  "book_mark_bank_and_account":{
    "bookMarkBankAndAccountId":"d8839721-ad8f-45dd-9f78-2080414b93f9",
    "bank_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d775",
    "account_id":"7791f8f5-50e1-4ea3-b6b4-c3d67c32d776",
    "tag_1":"Done"
  }
}
Required Roles:
  • CanUpdateDynamicEntity_BookMarkBankAndAccount - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
  • OBP-20006: User is missing one or more roles:
Connector Methods:
Version: OBPv4.0.0, function_name: by dynamicEntity_updateMyBookMarkBankAndAccount_Gen1_Aeena, operation_id: OBPv4.0.0-dynamicEntity_updateMyBookMarkBankAndAccount_Gen1_Aeena Tags: _Book Mark Bank And Account(Gen1 Aeena), Dynamic-Entity, Dynamic,